Network Vulnerability Scanner - User Manual
=========================================

This guide explains how to set up and use the Network Vulnerability Scanner on Windows.

----------------------------------------
QUICK START
----------------------------------------

Prerequisites (Important!)
-------------------------
1. Npcap Installation Required: Before running the scanner, you must manually install Npcap:
   - Download Npcap from: https://npcap.com/
   - Run the installer and follow the prompts
   - This is required for Nmap to function properly

2. Administrator Mode: The batch file must be run as Administrator for proper functionality:
   - Right-click on setup_scanner.bat
   - Select "Run as administrator"
   - This is especially important for scanning privileged ports (like port 80)

Option 1: Using the GUI (Recommended)
-------------------------------------
1. Open the 'Code' folder in your Downloads.
2. Right-click on the file named setup_scanner.bat
3. Select "Run as administrator"
4. Wait for the setup to finish. The web app will open in your browser at http://127.0.0.1:5000/
5. Use the web page to enter a target and select ports, then click 'Scan'.
   - The target field is pre-filled with scanme.nmap.org for testing

Option 2: Using the Command Line
-------------------------------
1. Open Command Prompt as Administrator (Win+R, type cmd, press Ctrl+Shift+Enter).
2. Navigate to the Code folder:
   cd %USERPROFILE%\Downloads\Networkscanner000\Code
3. Install dependencies:
   pip install -r requirements.txt
4. Run the app:
   python app.py
5. Open your browser and go to http://127.0.0.1:5000/

----------------------------------------
WEB INTERFACE GUIDE
----------------------------------------

Navigation Menu
--------------
- HOME: Main scanning interface
- PORTS INFORMATION: Educational content about common ports
- SERVICE: Pricing and service information
- ABOUT: Project information and credits
- CONTACT US: Support information

Main Interface Elements
---------------------
1. Target Input Field: Enter IP address or hostname to scan
   - Examples: 192.168.1.1, example.com, scanme.nmap.org
   
2. Port Selection: Choose from common ports or add custom ports
   - Common ports: 21, 22, 23, 25, 53, 80, 110, 139, 143, 443, 445, 3389, 3306, 8080, 5900, 1723, 8000, 8443
   - Custom ports: Enter comma-separated values (e.g., 8080,9000)
   - Port ranges: Use format start-end (e.g., 1000-2000)
   
3. Scan Button: Initiates the network scan
   - Shows progress and completion status
   
4. Results Display: Shows scan results in real-time
   - Port status (Open/Closed/Filtered)
   - Service detection (HTTP, SSH, FTP, etc.)
   - Version information
   - CVE vulnerability data

----------------------------------------
PERFORMING SCANS
----------------------------------------

Basic Scan Procedure
-------------------
1. Enter Target: Clear the field and enter the target IP or hostname
2. Select Ports: Choose from common ports or add custom ports
3. Click Scan: Wait for completion and review results

Example Targets:
- scanme.nmap.org (test target, always available)
- 192.168.1.1 (local router)
- example.com (external website)

Advanced Scanning
----------------
- Port Ranges: Use format like "1000-2000" for comprehensive scans
- Custom Lists: Enter "80,443,8080,8443" for specific services
- Service-Specific: 
  - Web: 80, 443, 8080, 8443
  - Database: 3306, 5432, 1433
  - Remote Access: 22, 23, 3389

----------------------------------------
UNDERSTANDING RESULTS
----------------------------------------

Scan Results Structure
--------------------
1. Target Information: Shows target, scan time, and duration
2. Port Status Table: 
   - Port number and protocol
   - State (Open/Closed/Filtered)
   - Service name and version
   - CVE vulnerability information

Interpreting Results
-------------------
- Open Ports: Service is running and accessible (investigate for vulnerabilities)
- Closed Ports: No service listening (generally safe)
- Filtered Ports: Firewall blocking access (may indicate security measures)

CVE Information
---------------
- CVE ID: Unique vulnerability identifier
- Severity: Critical, High, Medium, Low
- Description: Vulnerability details
- References: Links to additional information

----------------------------------------
SECURITY GUIDELINES
----------------------------------------

Legal Considerations
------------------
- Always obtain permission before scanning any target
- Only scan systems you own or have explicit authorization to test
- Be aware of legal implications of unauthorized scanning
- Document authorization for compliance purposes

Best Practices
-------------
- Start with test targets like scanme.nmap.org
- Use appropriate scan intensity for your needs
- Respect network policies and restrictions
- Monitor scan impact on target systems
- Keep results secure as they may contain sensitive information

Ethical Usage
------------
- Responsible disclosure: Report findings to system owners
- Minimize network impact: Choose appropriate scan timing
- Follow security frameworks: OWASP, NIST guidelines
- Maintain documentation: Keep records of authorized scans

----------------------------------------
TROUBLESHOOTING
----------------------------------------

Common Issues and Solutions
--------------------------

Issue 1: "Nmap program was not found in path"
- Solution: Install Npcap and run as Administrator

Issue 2: Port 80/443 not scanning
- Solution: Run as Administrator (required for privileged ports)

Issue 3: Scan not starting
- Solution: Check target format and network connectivity

Issue 4: No CVE information displayed
- Solution: Check internet connectivity and CVE API accessibility

Issue 5: Web interface not loading
- Solution: Verify Python/Flask installation and port availability

Debug Information
----------------
- Check console output for error messages
- Verify all prerequisites are installed
- Ensure Administrator privileges
- Test with scanme.nmap.org first

----------------------------------------
ADVANCED FEATURES
----------------------------------------

Custom Port Ranges
-----------------
- Single port: 80
- Multiple ports: 80,443,8080
- Port range: 1000-2000
- Mixed: 80,443,1000-2000,8080

Service Detection
----------------
- Web Servers: Apache, Nginx, IIS
- Database: MySQL, PostgreSQL, SQL Server
- Remote Access: SSH, Telnet, RDP
- File Transfer: FTP, SFTP
- Mail Services: SMTP, POP3, IMAP

CVE Database Integration
-----------------------
- Real-time lookup for detected services
- Version-specific vulnerability matching
- Comprehensive vulnerability database
- Severity ratings and detailed descriptions

----------------------------------------
PERFORMANCE TIPS
----------------------------------------

Scan Optimization
----------------
- Use port ranges instead of individual ports for large scans
- Choose appropriate timing to minimize network impact
- Monitor system resources during scans
- Archive old results to save storage space

Network Considerations
--------------------
- Scan during off-peak hours to reduce impact
- Notify network administrators before large scans
- Monitor bandwidth usage during scans
- Use appropriate scan intensity for your needs

----------------------------------------
NOTES
----------------------------------------
- The first run may take a few minutes to install Python and dependencies.
- Always run the app from inside the Code folder.
- The web interface is available as long as the app is running in the terminal/command prompt.
- To stop the app, close the terminal/command prompt window or press Ctrl+C.
- The scanner includes common ports like 21, 22, 23, 25, 53, 80, 443, etc.
- scanme.nmap.org is pre-filled as the default target for testing purposes.
- Results may contain sensitive information - handle with care.
- Regular security assessments help maintain network security.

----------------------------------------
SUPPORT
----------------------------------------
- Check the troubleshooting section for common issues
- Review console output for error messages
- Test with scanme.nmap.org before scanning other targets
- Ensure all prerequisites are properly installed
- Run as Administrator for full functionality

Version: 1.0
Last Updated: January 2025
License: Educational Use Only 